adc28.h File Reference

This file contains API for ADC 28 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures
struct	adc28_t
	ADC 28 Click context object. More...
struct	adc28_cfg_t
	ADC 28 Click configuration object. More...

Macros
#define	ADC28_REG_SYSTEM_STATUS   0x00
	ADC 28 register map.
#define	ADC28_REG_GENERAL_CFG   0x01
#define	ADC28_REG_DATA_CFG   0x02
#define	ADC28_REG_BUSY_CFG   0x03
#define	ADC28_REG_OPMODE_CFG   0x04
#define	ADC28_REG_PIN_CFG   0x05
#define	ADC28_REG_GPO_VALUE   0x0B
#define	ADC28_REG_SEQUENCE_CFG   0x10
#define	ADC28_REG_MANUAL_CH_SEL   0x11
#define	ADC28_REG_AUTO_SEQ_CH_SEL   0x12
#define	ADC28_REG_ALERT_CH_SEL   0x14
#define	ADC28_REG_EVENT_FLAG   0x18
#define	ADC28_REG_EVENT_HIGH_FLAG   0x1A
#define	ADC28_REG_EVENT_LOW_FLAG   0x1C
#define	ADC28_REG_EVENT_RGN   0x1E
#define	ADC28_REG_HYSTERESIS_CH0   0x20
#define	ADC28_REG_HIGH_TH_CH0   0x21
#define	ADC28_REG_EVENT_COUNT_CH0   0x22
#define	ADC28_REG_LOW_TH_CH0   0x23
#define	ADC28_REG_HYSTERESIS_CH1   0x24
#define	ADC28_REG_HIGH_TH_CH1   0x25
#define	ADC28_REG_EVENT_COUNT_CH1   0x26
#define	ADC28_REG_LOW_TH_CH1   0x27
#define	ADC28_REG_HYSTERESIS_CH2   0x28
#define	ADC28_REG_HIGH_TH_CH2   0x29
#define	ADC28_REG_EVENT_COUNT_CH2   0x2A
#define	ADC28_REG_LOW_TH_CH2   0x2B
#define	ADC28_REG_HYSTERESIS_CH3   0x2C
#define	ADC28_REG_HIGH_TH_CH3   0x2D
#define	ADC28_REG_EVENT_COUNT_CH3   0x2E
#define	ADC28_REG_LOW_TH_CH3   0x2F
#define	ADC28_REG_HYSTERESIS_CH4   0x30
#define	ADC28_REG_HIGH_TH_CH4   0x31
#define	ADC28_REG_EVENT_COUNT_CH4   0x32
#define	ADC28_REG_LOW_TH_CH4   0x33
#define	ADC28_REG_HYSTERESIS_CH5   0x34
#define	ADC28_REG_HIGH_TH_CH5   0x35
#define	ADC28_REG_EVENT_COUNT_CH5   0x36
#define	ADC28_REG_LOW_TH_CH5   0x37
#define	ADC28_REG_HYSTERESIS_CH6   0x38
#define	ADC28_REG_HIGH_TH_CH6   0x39
#define	ADC28_REG_EVENT_COUNT_CH6   0x3A
#define	ADC28_REG_LOW_TH_CH6   0x3B
#define	ADC28_REG_HYSTERESIS_CH7   0x3C
#define	ADC28_REG_HIGH_TH_CH7   0x3D
#define	ADC28_REG_EVENT_COUNT_CH7   0x3E
#define	ADC28_REG_LOW_TH_CH7   0x3F
#define	ADC28_REG_RECENT_CH0_LSB   0xA0
#define	ADC28_REG_RECENT_CH0_MSB   0xA1
#define	ADC28_REG_RECENT_CH1_LSB   0xA2
#define	ADC28_REG_RECENT_CH1_MSB   0xA3
#define	ADC28_REG_RECENT_CH2_LSB   0xA4
#define	ADC28_REG_RECENT_CH2_MSB   0xA5
#define	ADC28_REG_RECENT_CH3_LSB   0xA6
#define	ADC28_REG_RECENT_CH3_MSB   0xA7
#define	ADC28_REG_RECENT_CH4_LSB   0xA8
#define	ADC28_REG_RECENT_CH4_MSB   0xA9
#define	ADC28_REG_RECENT_CH5_LSB   0xAA
#define	ADC28_REG_RECENT_CH5_MSB   0xAB
#define	ADC28_REG_RECENT_CH6_LSB   0xAC
#define	ADC28_REG_RECENT_CH6_MSB   0xAD
#define	ADC28_REG_RECENT_CH7_LSB   0xAE
#define	ADC28_REG_RECENT_CH7_MSB   0xAF
#define	ADC28_OPCODE_SINGLE_READ   0x10
	ADC 28 I2C OPCODE commands setting.
#define	ADC28_OPCODE_SINGLE_WRITE   0x08
#define	ADC28_OPCODE_SET_BIT   0x18
#define	ADC28_OPCODE_CLEAR_BIT   0x20
#define	ADC28_OPCODE_BLOCK_READ   0x30
#define	ADC28_OPCODE_BLOCK_WRITE   0x28
#define	ADC28_SYSTEM_STATUS_BOR   0x01
	ADC 28 SYSTEM_STATUS register setting.
#define	ADC28_SYSTEM_STATUS_I2C_SPEED   0x20
#define	ADC28_SYSTEM_STATUS_SEQ_STATUS   0x40
#define	ADC28_GENERAL_CFG_RST   0x01
	ADC 28 GENERAL_CFG register setting.
#define	ADC28_GENERAL_CFG_DWC_EN   0x10
#define	ADC28_GENERAL_CFG_STATS_EN   0x20
#define	ADC28_DATA_CFG_APPEND_STATUS_NONE   0x00
	ADC 28 DATA_CFG register setting.
#define	ADC28_DATA_CFG_APPEND_STATUS_CHID   0x10
#define	ADC28_DATA_CFG_APPEND_STATUS_ALERT   0x20
#define	ADC28_DATA_CFG_FIX_PAT   0x80
#define	ADC28_BUSY_CFG_BUSYTIME_1_2US   0x00
	ADC 28 BUSY_CFG register setting.
#define	ADC28_BUSY_CFG_BUSYTIME_6_0US   0xC0
#define	ADC28_OPMODE_CFG_CLK_DIV_0_75MS   0x00
	ADC 28 OPMODE_CFG register setting.
#define	ADC28_OPMODE_CFG_CLK_DIV_1_5MS   0x01
#define	ADC28_OPMODE_CFG_CLK_DIV_3MS   0x02
#define	ADC28_OPMODE_CFG_CLK_DIV_6MS   0x03
#define	ADC28_OPMODE_CFG_CONV_MODE_MANUAL   0x00
#define	ADC28_OPMODE_CFG_CONV_MODE_AUTO   0x20
#define	ADC28_SEQUENCE_CFG_SEQ_MODE_MANUAL   0x00
	ADC 28 SEQUENCE_CFG register setting.
#define	ADC28_SEQUENCE_CFG_SEQ_MODE_AUTO   0x01
#define	ADC28_SEQUENCE_CFG_SEQ_START   0x10
#define	ADC28_CHANNEL_0   0x00
	ADC 28 channel selection setting.
#define	ADC28_CHANNEL_1   0x01
#define	ADC28_CHANNEL_2   0x02
#define	ADC28_CHANNEL_3   0x03
#define	ADC28_CHANNEL_4   0x04
#define	ADC28_CHANNEL_5   0x05
#define	ADC28_CHANNEL_6   0x06
#define	ADC28_CHANNEL_7   0x07
#define	ADC28_CHANNEL_MASK   0x0F
#define	ADC28_AUTO_SEQ_CH0   0x01
	ADC 28 AUTO_SEQ_CH_SEL bitmask setting.
#define	ADC28_AUTO_SEQ_CH1   0x02
#define	ADC28_AUTO_SEQ_CH2   0x04
#define	ADC28_AUTO_SEQ_CH3   0x08
#define	ADC28_AUTO_SEQ_CH4   0x10
#define	ADC28_AUTO_SEQ_CH5   0x20
#define	ADC28_AUTO_SEQ_CH6   0x40
#define	ADC28_AUTO_SEQ_CH7   0x80
#define	ADC28_AUTO_SEQ_ALL_CH   0xFF
#define	ADC28_ADC_RESOLUTION   4096.0f
	ADC 28 data resolution and VDD setting.
#define	ADC28_VDD_3V3   3.3f
#define	ADC28_VDD_5V   5.0f
#define	ADC28_THRESHOLD_LIMIT   0x0FFF
	ADC 28 data threshold, hysteresis and even count setting.
#define	ADC28_HYSTERESIS_LIMIT   0x0F
#define	ADC28_EVENT_COUNT_LIMIT   0x0F
#define	ADC28_HYSTERESIS_MASK   0x0F
#define	ADC28_EVENT_COUNT_MASK   0x0F
#define	ADC28_HIGH_THR_MSB_MASK   0xFF
#define	ADC28_LOW_THR_MSB_MASK   0xFF
#define	ADC28_HIGH_THR_LSB_MASK   0xF0
#define	ADC28_LOW_THR_LSB_MASK   0xF0
#define	ADC28_4_LSB_MASK   0x000F
#define	ADC28_DEVICE_ADDR_R1_0_R2_OPEN   0x17
	ADC 28 device address setting.
#define	ADC28_DEVICE_ADDR_R1_100K_R2_OPEN   0x14
#define	ADC28_DEVICE_ADDR_R1_OPEN_R2_0   0x10
#define	ADC28_DEVICE_ADDR_R1_OPEN_R2_100K   0x13
#define	ADC28_DEVICE_ADDRESS   ADC28_DEVICE_ADDR_R1_0_R2_OPEN
#define	ADC28_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	adc28_return_value_t { ADC28_OK = 0 , ADC28_ERROR = -1 }
	ADC 28 Click return value data. More...

Functions
void	adc28_cfg_setup (adc28_cfg_t *cfg)
	ADC 28 configuration object setup function.
err_t	adc28_init (adc28_t *ctx, adc28_cfg_t *cfg)
	ADC 28 initialization function.
err_t	adc28_default_cfg (adc28_t *ctx)
	ADC 28 default configuration function.
err_t	adc28_write_reg (adc28_t *ctx, uint8_t reg, uint8_t data_in)
	ADC 28 write register function.
err_t	adc28_write_regs (adc28_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
	ADC 28 write registers function.
err_t	adc28_read_reg (adc28_t *ctx, uint8_t reg, uint8_t *data_out)
	ADC 28 read register function.
err_t	adc28_read_regs (adc28_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
	ADC 28 read registers function.
uint8_t	adc28_get_alert_pin (adc28_t *ctx)
	ADC 28 get alert pin function.
err_t	adc28_set_high_threshold (adc28_t *ctx, uint8_t channel, uint16_t high_th)
	ADC 28 set high threshold function.
err_t	adc28_set_low_threshold (adc28_t *ctx, uint8_t channel, uint16_t low_th)
	ADC 28 set low threshold function.
err_t	adc28_set_hysteresis (adc28_t *ctx, uint8_t channel, uint8_t hysteresis)
	ADC 28 set hysteresis function.
err_t	adc28_set_event_count (adc28_t *ctx, uint8_t channel, uint8_t event_count)
	ADC 28 set event count function.
err_t	adc28_read_raw_adc (adc28_t *ctx, uint8_t channel, uint16_t *raw_data)
	ADC 28 read raw ADC function.
err_t	adc28_read_voltage (adc28_t *ctx, uint8_t channel, float *voltage)
	ADC 28 read voltage function.

Detailed Description

This file contains API for ADC 28 Click Driver.

Enumeration Type Documentation

adc28_return_value_t

enum adc28_return_value_t

ADC 28 Click return value data.

Predefined enum values for driver return values.

Enumerator
ADC28_OK
ADC28_ERROR